Skip to content

feat: support reading AsyncAPI documents from stdin using "-" (#2011) - #2136

Open
useye wants to merge 1 commit into
asyncapi:masterfrom
useye:feat/issue-2011-stdin-support
Open

feat: support reading AsyncAPI documents from stdin using "-" (#2011)#2136
useye wants to merge 1 commit into
asyncapi:masterfrom
useye:feat/issue-2011-stdin-support

Conversation

@useye

@useye useye commented Apr 22, 2026

Copy link
Copy Markdown

Summary

Added support for reading AsyncAPI documents from stdin by passing - as the file argument.

This follows the widely-used Unix convention where - represents stdin/stdout.

Changes

  1. Added Specification.fromStdin() method that reads from process.stdin
  2. Modified load() function to detect - as the special stdin indicator

Usage Examples

# Read from stdin
cat asyncapi.yaml | asyncapi validate -

# Generate fromTemplate with stdin input
asyncapi generate fromTemplate - @asyncapi/html-template -o out < input.yaml

# Validate with stdin
asyncapi validate - < spec.json

Error Handling

If stdin is empty, a clear error message is shown: "Not enough non-option arguments: expected at least one"

Related Issue

Fixes #2011

@github-project-automation github-project-automation Bot moved this to To Triage in CLI - Kanban Apr 22, 2026
@changeset-bot

changeset-bot Bot commented Apr 22, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b6f4ddc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@sonarqubecloud

sonarqubecloud Bot commented Apr 22, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

This pull request has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions Bot added the stale label Sep 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Souvikns Souvikns Awaiting requested review from Souvikns Souvikns is a code owner
@Amzani Amzani Awaiting requested review from Amzani Amzani is a code owner
@Shurtu-gal Shurtu-gal Awaiting requested review from Shurtu-gal Shurtu-gal is a code owner
@asyncapi-bot-eve asyncapi-bot-eve Awaiting requested review from asyncapi-bot-eve asyncapi-bot-eve is a code owner
@AayushSaini101 AayushSaini101 Awaiting requested review from AayushSaini101 AayushSaini101 is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

stale

Projects

CLI - Kanban
Status: To Triage

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[BUG] CLI does not support reading AsyncAPI documents from stdin (-) and fails with misleading error

1 participant

@useye